Package com.cisco.pt.ipc.system.impl
Class EMEAScriptEngineImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.EMEAScriptEngineImpl
- All Implemented Interfaces:
IPCObject,EMEAScriptEngine
- Direct Known Subclasses:
ActivityScriptEngineImpl
Information provided by the PKI file:
\class EMEAScriptEngine
\brief EMEAScriptEngine gives access to Packet Tracer's Script Engine.
\example appWindow().getActiveFile().getScriptEngine()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionEMEAScriptEngineImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionbooleancanEvaluate(String program) Information provided by the PKI file:createScriptValueBool(boolean value) Information provided by the PKI file:createScriptValueInt(int value) Information provided by the PKI file:createScriptValueQString(String value) Information provided by the PKI file:Information provided by the PKI file:evaluateFile(String filepath) Information provided by the PKI file:Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
EMEAScriptEngineImpl
public EMEAScriptEngineImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
evaluateFile
Information provided by the PKI file:
\brief Evaluates the specified script. \param filepath, the filepath of the script of interest. \return ScriptValue, the ScriptValue object of the specified script.- Specified by:
evaluateFilein interfaceEMEAScriptEngine- Parameters:
filepath- Takes in a parameter of filepath- Returns:
- ScriptValue Returns a ScriptValue
-
canEvaluate
Information provided by the PKI file:
\brief Returns true if the specified script can be evaluated, otherwise false. \param program, the code of the script of interest. \return bool, true if the specified script can be evaluated, otherwise false.- Specified by:
canEvaluatein interfaceEMEAScriptEngine- Parameters:
program- Takes in a parameter of program- Returns:
- boolean Returns a boolean
-
globalObject
Information provided by the PKI file:
\brief Returns the global ScriptValue object. \return ScriptValue, the global ScriptValue object.- Specified by:
globalObjectin interfaceEMEAScriptEngine- Returns:
- ScriptValue Returns a ScriptValue
-
evaluate
Information provided by the PKI file:
\brief Evaluates the specified script. \param program, the code of the script of interest. \param id, the name of the script of interest. \return ScriptValue, the ScriptValue object of the specified script.- Specified by:
evaluatein interfaceEMEAScriptEngine- Parameters:
program- Takes in a parameter of programid- Takes in a parameter of id- Returns:
- ScriptValue Returns a ScriptValue
-
createScriptValueInt
Information provided by the PKI file:
\brief Creates a ScriptValue object with the specified integer value. \param value, the integer value of the ScriptValue object. \return ScriptValue, the ScriptValue object.- Specified by:
createScriptValueIntin interfaceEMEAScriptEngine- Parameters:
value- Takes in a parameter of value- Returns:
- ScriptValue Returns a ScriptValue
-
createScriptValueBool
Information provided by the PKI file:
\brief Creates a ScriptValue object with the specified boolean value. \param value, the boolean value of the ScriptValue object. \return ScriptValue, the ScriptValue object.- Specified by:
createScriptValueBoolin interfaceEMEAScriptEngine- Parameters:
value- Takes in a parameter of value- Returns:
- ScriptValue Returns a ScriptValue
-
createScriptValueQString
Information provided by the PKI file:
\brief Creates a ScriptValue object with the specified QString value. \param value, the QString value of the ScriptValue object. \return ScriptValue, the ScriptValue object.- Specified by:
createScriptValueQStringin interfaceEMEAScriptEngine- Parameters:
value- Takes in a parameter of value- Returns:
- ScriptValue Returns a ScriptValue
-